/*
 * 版权所有 (C) 2015 知启蒙(ZHIQIM) 保留所有权利。[遇见知启蒙，邂逅框架梦]
 * 
 * https://zhiqim.org/project/zhiqim_framework/zhiqim_httpd.htm
 *
 * Zhiqim Httpd is licensed under Mulan PSL v2.
 * You can use this software according to the terms and conditions of the Mulan PSL v2.
 * You may obtain a copy of Mulan PSL v2 at:
 *          http://license.coscl.org.cn/MulanPSL2
 * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
 * EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
 * MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 * See the Mulan PSL v2 for more details.
 */
package org.zhiqim.httpd.context.core;

import java.util.List;

import org.zhiqim.httpd.HttpContext;
import org.zhiqim.httpd.HttpHandler;
import org.zhiqim.httpd.context.ZmlBootstrap;
import org.zhiqim.httpd.context.ZmlConfig;
import org.zhiqim.httpd.context.ZmlContextConstants;
import org.zhiqim.httpd.context.ServiceExecutor;
import org.zhiqim.httpd.context.config.ZAction;
import org.zhiqim.zml.ZmlEngine;

/**
 * ZML上下文环境必须实现的接口
 *
 * @version v1.0.0 @author zouzhigang 2016-7-16 新建与整理
 */
public interface Context extends HttpContext, ZmlContextConstants
{
    /***************************************************************************************/
    //Bootstrap & RmiService & ZmlEngine
    /***************************************************************************************/
    
    /** 获取服务Id */
    public String getServerId();
    
    /** 获取配置类 */
    public ZmlConfig getConfig();
    
    /** 获取引导类 */
    public ZmlBootstrap getBootstrap();
    
    /** 获取ZML引擎类 */
    public ZmlEngine getZmlEngine();
    
    /** 获取服务处理器 */
    public ServiceExecutor getServiceExecutor();
    
    /***************************************************************************************/
    //TopAttribute
    /***************************************************************************************/
    
    /** 判断是否有顶级属性 */
    public boolean hasTopAttribute(String key);
    
    /** 获取顶有属性对象 */
    public Object getTopAttribute(String key);
    
    /** 获取顶有属性字符串 */
    public String getTopAttributeString(String key);
    
    /** 获取顶有属性字符串，有属性则返回字符串，否则返回缺省值 */
    public String getTopAttributeString(String key, String defaultValue);
    
    /***************************************************************************************/
    //Action & Interceptor
    /***************************************************************************************/
    
    /**
     * 通过ZAction配置获取Action实例
     * 
     * @param fAction       ZAction配置
     * @return              Action实例
     */
    public Action getAction(ZAction fAction);
    
    /**
     * 判断类是否在ActionMap中
     * 
     * @param clazz         类名
     * @return              =true表示存在
     */
    public boolean hasActionInstance(String clazz);
    
    /**
     * 获取类在ActionMap中的实例
     * 
     * @param clazz         类名
     * @return              Action实例
     */
    public Action getActionInstance(String clazz);
    
    /**
     * 获取Action配置
     * 
     * @param path          路径，如/index.htm
     * @return              Action配置
     */
    public ZAction getAction(String path);
    
    /**
     * 判断是否有该别名的拦截器
     * 
     * @param interceptor   拦截器别名
     * @return              =true表示有，=false表示没有
     */
    public boolean hasInterceptor(String interceptor);
    
    /**
     * 获取该别名的拦截器
     * 
     * @param interceptor   拦截器别名
     * @return              拦截器
     */
    public Interceptor getInterceptor(String interceptor);
    
    /**
     * 通过拦截器别名字符串获取拦截器列表
     * 
     * @param interceptors  拦截器别名字符串，多个用逗号隔开
     * @return              拦截器列表
     */
    public List<Interceptor> getInterceptorList(String interceptors);

    /** 
     * 增加Handler处理器，Handler在Action、Interceptor之前，规则如下：
     * 
     * 1.精确匹配,/开头后加字符串,如/match, /match.do
     * 2.最长路径匹配,使用/*标识,如/match/*
     * 3.扩展匹配,不允许出现/字符,如*.do, *.action
     * 4.缺省匹配,/字符串,当查询前三个不成功时,跳转到ResourceHandler处理,如果资源未找到,则转到缺省匹配
     * 5.如果前四种都失败,返回系统404页面
     * 
     * @param handler   处理器
     * @return          =true表示增加成功，=false表示增加失败
     */
    public boolean addHandler(HttpHandler handler);
}
